[Enterprise Search] Support for starting ELSER model deployment #156080

demjened · 2023-04-27T19:15:06Z

Summary

We're adding action buttons to the ELSER model deployment panel, specifically to the state where the trained model has been downloaded but not started yet. The user has two options here:

Start the model (synchronously) with a basic configuration using the "Start single-threaded" button
Navigate to the Trained Models page and fine-tune the model deployment with the "Fine-tune performance" button

In addition a 4th state of the panel is being introduced: the ELSER model has started.

Checklist

Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
Unit or functional tests were updated or added to match the most common scenarios
Any UI touched in this PR is usable by keyboard only (learn more about keyboard accessibility)
This renders correctly on smaller devices using a responsive layout. (You can test this in your browser)

...ise_search_content/components/search_index/pipelines/ml_inference/text_expansion_callout.tsx

…-ref HEAD~1..HEAD --fix'

julianrosado · 2023-04-27T19:47:00Z

Need between paragraph and action buttons (giving it a 24px space)
Is there a reason why the title icon and text needs to be black? In a success callout it should be green
I know this might be out of scope, but I am still curious if there's any way we can let users know their models are running in a non-ideal but dev ready state (single-threaded)?

demjened · 2023-04-27T20:02:41Z

Need between paragraph and action buttons (giving it a 24px space)

Ok, will update.

Is there a reason why the title icon and text needs to be black? In a success callout it should be green

I'm actually using EuiPanel but I think it should behave the same way. The culprit seems to be FormattedMessage inside an EuiTitle, I'm not sure how to color these because neither of them takes a color attribute. Maybe @TattdCodeMonkey or @sphilipse knows?
For reference this is what it's supposed to look like according to the design:

I know this might be out of scope, but I am still curious if there's any way we can let users know their models are running in a non-ideal but dev ready state (single-threaded)?

My plan is to make these critical state transitions safe, then I'll play around with the different use cases. You're talking about the cases when the user started with the Start button vs did a deployment on multiple threads?

…-fix'

julianrosado · 2023-04-27T20:16:26Z

Ok, will update.

You da man

I'm actually using EuiPanel but I think it should behave the same way.

Ah I see, I was anticipating EuiCallout which does that auto-magically. I don't think Title accept color params. If it's not a simple change don't waste brain cycles on it.

You're talking about the cases when the user started with the Start button vs did a deployment on multiple threads?

Yeah, if you started it single-threaded just to get development going, but then forget to change it to multi threaded for production specifically because we don't surface that information somewhere useful in this screen. If that is outside the scope of this release that's fine but I'd want to have something for that moving forward.

...ise_search_content/components/search_index/pipelines/ml_inference/text_expansion_callout.tsx

...earch_content/components/search_index/pipelines/ml_inference/text_expansion_callout_logic.ts

sphilipse · 2023-04-28T08:04:37Z

...terprise_search_content/api/ml_models/text_expansion/start_text_expansion_model_api_logic.ts

+import { Actions, createApiLogic } from '../../../../shared/api_logic/create_api_logic';
+import { HttpLogic } from '../../../../shared/http';
+
+export type StartTextExpansionModelArgs = undefined;


nitpick(non-blocking): Best practice is to specify an empty object rather than undefined.

Hm, this is breaking the type checks:

/var/lib/buildkite-agent/builds/kb-n2-2-spot-a440796eab9fe2c4/elastic/kibana-pull-request/kibana/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/api/ml_models/text_expansion/create_text_expansion_model_api_logic.ts -- | 2023-04-28 11:19:48 EDT | 11:18 error An empty interface is equivalent to `{}` @typescript-eslint/no-empty-interface

@sphilipse I reverted to undefined because I couldn't find a way to fix the CI error.

Sorry, what you want to do instead is use {} wherever you're using StartTextExpansionModelArgs. But this is a nitpick anyway.

...ise_search_content/components/search_index/pipelines/ml_inference/text_expansion_callout.tsx

…-ref HEAD~1..HEAD --fix'

…b.com/demjened/kibana into demjened/elser-start-model-deployment

…-fix'

sphilipse

Thanks for addressing everything! Looks good to me.

demjened · 2023-05-01T14:03:42Z

@elasticmachine merge upstream

kibana-ci · 2023-05-01T14:56:06Z

💚 Build Succeeded

Buildkite Build
Commit: 86bdf84

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`enterpriseSearch`	2077	2078	+1

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
`enterpriseSearch`	2.3MB	2.3MB	+2.8KB

Unknown metric groups

ESLint disabled line counts

id	before	after	diff
`enterpriseSearch`	19	21	+2
`securitySolution`	399	402	+3
total			+5

Total ESLint disabled count

id	before	after	diff
`enterpriseSearch`	20	22	+2
`securitySolution`	479	482	+3
total			+5

History

💔 Build #124492 failed 0e9a02c
💔 Build #124468 failed 5c04bac
💔 Build #124346 failed 0c79e4b
💔 Build #124312 failed eb99068
💛 Build #124097 was flaky c4ce39a
💔 Build #124084 failed 7135960

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

…tic#156080) ## Summary We're adding action buttons to the ELSER model deployment panel, specifically to the state where the trained model has been downloaded but not started yet. The user has two options here: - Start the model (synchronously) with a basic configuration using the "Start single-threaded" button - Navigate to the Trained Models page and fine-tune the model deployment with the "Fine-tune performance" button In addition a 4th state of the panel is being introduced: the ELSER model has started. ![ELSER_start](https://user-images.githubusercontent.com/14224983/234971172-a99917dd-ec55-4df3-acd1-a6b390262104.gif) ### Checklist - [x] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md) - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios - [x] Any UI touched in this PR is usable by keyboard only (learn more about [keyboard accessibility](https://webaim.org/techniques/keyboard/)) - [x] This renders correctly on smaller devices using a responsive layout. (You can test this [in your browser](https://www.browserstack.com/guide/responsive-testing-on-local-server)) --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> (cherry picked from commit 5897708)

kibanamachine · 2023-05-01T15:02:17Z

💚 All backports created successfully

Status	Branch	Result
✅	8.8

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

…#156080) (#156266) # Backport This will backport the following commits from `main` to `8.8`: - [[Enterprise Search] Support for starting ELSER model deployment (#156080)](#156080)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport)  Co-authored-by: Adam Demjen <demjened@gmail.com>

demjened added 4 commits April 27, 2023 12:44

Add start deployment button and deployed state

b9b9b3f

Add deployment actions

65af853

Link start button action & disabling logic

a965424

Add unit tests

4ba092e

demjened added release_note:feature Makes this part of the condensed release notes Team:EnterpriseSearch v8.8.0 labels Apr 27, 2023

Mooooar unit tests

7135960

demjened commented Apr 27, 2023

View reviewed changes

...ise_search_content/components/search_index/pipelines/ml_inference/text_expansion_callout.tsx Outdated Show resolved Hide resolved

demjened commented Apr 27, 2023

View reviewed changes

...ise_search_content/components/search_index/pipelines/ml_inference/text_expansion_callout.tsx Outdated Show resolved Hide resolved

Deduplicate i18n key

a82f0ac

demjened marked this pull request as ready for review April 27, 2023 19:35

demjened requested a review from a team April 27, 2023 19:35

[CI] Auto-commit changed files from 'node scripts/precommit_hook.js -…

20e46b1

…-ref HEAD~1..HEAD --fix'

[CI] Auto-commit changed files from 'node scripts/eslint --no-cache -…

c4ce39a

…-fix'

demjened added the v8.9.0 label Apr 28, 2023

sphilipse requested changes Apr 28, 2023

View reviewed changes

demjened and others added 9 commits April 28, 2023 09:59

Fix missing aria-label (unrelated)

8314b54

Use EuiCallOut + address other CR comments

eb99068

Add spacer

601532d

[CI] Auto-commit changed files from 'node scripts/precommit_hook.js -…

6dd50e6

…-ref HEAD~1..HEAD --fix'

Align buttons with grow=false

26017ee

Merge branch 'demjened/elser-start-model-deployment' of https://githu…

293fdc5

…b.com/demjened/kibana into demjened/elser-start-model-deployment

[CI] Auto-commit changed files from 'node scripts/eslint --no-cache -…

0c79e4b

…-fix'

Minor style tweaks + revert empty interfaces

edff900

Merge branch 'main' into demjened/elser-start-model-deployment

5c04bac

demjened requested a review from sphilipse April 30, 2023 23:00

demjened requested a review from TattdCodeMonkey April 30, 2023 23:01

sphilipse approved these changes May 1, 2023

View reviewed changes

Merge branch 'main' into demjened/elser-start-model-deployment

0e9a02c

Merge branch 'main' into demjened/elser-start-model-deployment

86bdf84

TattdCodeMonkey approved these changes May 1, 2023

View reviewed changes

demjened merged commit 5897708 into elastic:main May 1, 2023

kibanamachine mentioned this pull request May 1, 2023

[8.8] [Enterprise Search] Support for starting ELSER model deployment (#156080) #156266

Merged

droberts195 mentioned this pull request May 2, 2023

Drafts download and deployment docs for ELSER elastic/stack-docs#2371

Merged

demjened deleted the demjened/elser-start-model-deployment branch May 5, 2023 15:25

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Enterprise Search] Support for starting ELSER model deployment #156080

[Enterprise Search] Support for starting ELSER model deployment #156080

demjened commented Apr 27, 2023 •

edited by kibanamachine

Loading

julianrosado commented Apr 27, 2023

demjened commented Apr 27, 2023

julianrosado commented Apr 27, 2023

sphilipse Apr 28, 2023

demjened Apr 28, 2023

demjened Apr 30, 2023

sphilipse May 1, 2023

sphilipse left a comment

demjened commented May 1, 2023

kibana-ci commented May 1, 2023

ESLint disabled line counts

Total ESLint disabled count

kibanamachine commented May 1, 2023

[Enterprise Search] Support for starting ELSER model deployment #156080

[Enterprise Search] Support for starting ELSER model deployment #156080

Conversation

demjened commented Apr 27, 2023 • edited by kibanamachine Loading

Summary

Checklist

julianrosado commented Apr 27, 2023

demjened commented Apr 27, 2023

julianrosado commented Apr 27, 2023

sphilipse Apr 28, 2023

Choose a reason for hiding this comment

demjened Apr 28, 2023

Choose a reason for hiding this comment

demjened Apr 30, 2023

Choose a reason for hiding this comment

sphilipse May 1, 2023

Choose a reason for hiding this comment

sphilipse left a comment

Choose a reason for hiding this comment

demjened commented May 1, 2023

kibana-ci commented May 1, 2023

💚 Build Succeeded

Metrics [docs]

Module Count

Async chunks

ESLint disabled line counts

Total ESLint disabled count

History

kibanamachine commented May 1, 2023

💚 All backports created successfully

Questions ?

demjened commented Apr 27, 2023 •

edited by kibanamachine

Loading